Node / ReticulumProjects / MeshChatX.git / files / docs / agents / README.md

Displaying Raw • View rendered • Download

Tc9d1d9# Agent guidance for MeshChatX

Neutral, tool-agnostic notes for automated agents and human contributors who work like agents.

This tree is **not** part of the in-app user documentation. End-user docs live under Ta5d6ff`docs/en/`.

Tc9d1d9## Start here

Tff7b721. Read [Tff7b72overview.md](Te6edf3overview.md) for architecture, storage, security, env vars, and invariants.

Tff7b722. Read [Tff7b72conventions/reticulum-zen.md](Te6edf3conventions/reticulum-zen.md) before any mesh-facing design or code.

Tff7b723. Apply [Tff7b72conventions/](Te6edf3conventions/) for the surface you are editing.

Tff7b724. Open a [Tff7b72skills/](Te6edf3skills/) guide when the task matches that workflow.

Root [Tff7b72AGENTS.md](Te6edf3../../AGENTS.md) is a short pointer to this directory.

Cursor rules under Ta5d6ff`.cursor/rules/`:

Tff7b72- Always on: Ta5d6ff`meshchatx-core.mdc`, Ta5d6ff`reticulum-zen-gates.mdc`

Tff7b72- Globs: Ta5d6ff`meshchatx-backend.mdc`, Ta5d6ff`meshchatx-frontend.mdc`, Ta5d6ff`meshchatx-android.mdc`, Ta5d6ff`meshchatx-tests.mdc`

Tc9d1d9## Layout

| Path | Purpose |

| ------------------------------------------------------------ | ------------------------------------- |

| [Tff7b72overview.md](Te6edf3overview.md) | Project brief and critical invariants |

| [Tff7b72conventions/reticulum-zen.md](Te6edf3conventions/reticulum-zen.md) | Zen of Reticulum hard gates |

| [Tff7b72conventions/core.md](Te6edf3conventions/core.md) | Always-on standards |

| [Tff7b72conventions/frontend.md](Te6edf3conventions/frontend.md) | Vue UI |

| [Tff7b72conventions/backend.md](Te6edf3conventions/backend.md) | Python / HTTP / SQLite |

| [Tff7b72conventions/android.md](Te6edf3conventions/android.md) | Android WebView bridge |

| [Tff7b72conventions/tests.md](Te6edf3conventions/tests.md) | Test placement and verification |

Tc9d1d9## Skills

Tc9d1d9### UI and wiring

| Skill | Use when |

| ------------------------------------------------------------------ | ------------------------------------------------------ |

| [Tff7b72page-toast-tests](Te6edf3skills/page-toast-tests/SKILL.md) | New pages, toasts, i18n, tests |

| [Tff7b72contribution-registries](Te6edf3skills/contribution-registries/SKILL.md) | Nav, tools, commands, settings search, WS event wiring |

Tc9d1d9### Identity and data

| Skill | Use when |

| -------------------------------------------------------------------------- | ------------------------------------------------- |

| [Tff7b72identity-restore](Te6edf3skills/identity-restore/SKILL.md) | Identity key vs database zip restore |

| [Tff7b72identity-switch-teardown](Te6edf3skills/identity-switch-teardown/SKILL.md) | Live identity switch without cross-identity leaks |

| [Tff7b72database-migrations-backups](Te6edf3skills/database-migrations-backups/SKILL.md) | Schema bumps, backups, snapshots, restore safety |

| [Tff7b72landlock-sqlite](Te6edf3skills/landlock-sqlite/SKILL.md) | Landlock + SQLite conversation failures |

Tc9d1d9### Security and plugins

| Skill | Use when |

| ------------------------------------------------------------------ | --------------------------------------------- |

| [Tff7b72reticulum-design-gates](Te6edf3skills/reticulum-design-gates/SKILL.md) | Mesh design review against Zen of Reticulum |

| [Tff7b72auth-csrf-ws-security](Te6edf3skills/auth-csrf-ws-security/SKILL.md) | CSRF, auth, WS mutator denylist |

| [Tff7b72plugin-install-security](Te6edf3skills/plugin-install-security/SKILL.md) | Plugin install, RSG, permissions, integrity |

| [Tff7b72rns-link-api](Te6edf3skills/rns-link-api/SKILL.md) | Generic RNS Link WebSocket / plugin transport |

Tc9d1d9### Platforms and boot

| Skill | Use when |

| ---------------------------------------------------------------------- | ------------------------------------------------- |

| [Tff7b72deferred-network-startup](Te6edf3skills/deferred-network-startup/SKILL.md) | HTTP-up vs RNS-ready, status, 503s, RNS panic |

| [Tff7b72electron-frozen-packaging](Te6edf3skills/electron-frozen-packaging/SKILL.md) | Frozen desktop spawn, loading, crash recovery |

| [Tff7b72android-webview-bridge](Te6edf3skills/android-webview-bridge/SKILL.md) | Android chooser MIME, storage, WebView navigation |

Tc9d1d9### Verification

| Skill | Use when |

| -------------------------------------- | ---------------------------------------- |

| [Tff7b72test-loop](Te6edf3skills/test-loop/SKILL.md) | Focused verification without hung shells |

Tc9d1d9## Product docs (users)

Tff7b72- Ta5d6ff`docs/en/architecture.md`

Tff7b72- Ta5d6ff`docs/en/identity-and-security.md`

Tff7b72- Ta5d6ff`docs/en/getting-started.md`

Tff7b72- Ta5d6ff`docs/en/rns-link-api.md`

Tff7b72- Ta5d6ff`docs/en/platform-guides/linux-sandbox.md`

Tff7b72- Ta5d6ff`CONTRIBUTING.md`